Skip to content

Conversation

doughillyer
Copy link

  • closes DOC: Enforce Numpy Docstring Validation (Parent Issue) #58063 (partially)
  • Tests added and passed if fixing a bug or adding a new feature
  • All code checks passed.
  • Added type annotations to new arguments/methods/functions.
  • Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

This PR validates and fixes the docstrings for pandas.tseries.offsets.BusinessDay and several of its properties to conform with the NumPy docstring standard.

The following changes were made:

  • Moved the Parameters section from the BusinessDay class docstring to the __init__ method of the parent BusinessMixin class to resolve a PR02 validation error. This aligns with the NumPy docstring standard.
  • Added fully-featured docstrings (including See Also and Examples) to the .calendar, .holidays, and .weekmask properties to resolve GL08 errors.
  • Removed the now-passing methods from the ignore list in ci/code_checks.sh.

@doughillyer doughillyer requested a review from mroeschke as a code owner August 9, 2025 00:50
Copy link
Contributor

github-actions bot commented Sep 9, 2025

This pull request is stale because it has been open for thirty days with no activity. Please update and respond to this comment if you're still interested in working on this.

@github-actions github-actions bot added the Stale label Sep 9, 2025
@mroeschke
Copy link
Member

Thanks for the pull request, but it appears to have gone stale. If interested in continuing, please merge in the main branch, address any review comments and/or failing tests, and we can reopen.

@mroeschke mroeschke closed this Oct 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: Enforce Numpy Docstring Validation (Parent Issue)

2 participants